Platform Explorer / Nuxeo Platform 5.8

Contribution org.nuxeo.dam.contentviews--widgettypes

This contribution is part of XML component org.nuxeo.dam.contentviews inside nuxeo-dam-jsf-5.8.jar

Extension Point

Extension point widgettypes of component WebLayoutManager.

Contributed Items

  • <widgetType name="dam_listing_selection">
          <configuration>
            <sinceVersion>5.7</sinceVersion>
            <title>DAM Listing Selection</title>
            <description>
              <p>
                This widget type displays a selection checkbox, that will perform
                ajax selection of given item, and the asset title.
              </p>
              <p>
                It requires the following fields configuration:
                <ul>
                  <li>
                    first field maps the document model, it will be used to
                    display the title
                  </li>
                  <li>
                    second field maps the label used as the tooltip of the
                    document title
                  </li>
                  <li>
                    third field maps a boolean representing the selection state
                  </li>
                  <li>
                    fourth field maps the string identifier used to perform
                    selection
                  </li>
                </ul>
              </p>
              <p>
                It also requires the following variables to be present in the EL
                context:
                <ul>
                  <li>
                    provider: result provider used to get the list of items, its
                    name will be used.
                  </li>
                  <li>
                    listName: the name of the list that will hold selected items
                  </li>
                </ul>
              </p>
            </description>
            <fields>
              <list>false</list>
              <complex>false</complex>
              <defaultConfiguration>
                <field>data</field>
                <field>data.dc.description</field>
                <field>selected</field>
                <field>data.ref</field>
              </defaultConfiguration>
            </fields>
            <categories>
              <category>hidden_listing</category>
            </categories>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /dam/widgets/listing/listing_ajax_selection_box_with_title_widget_template.xhtml
          </property>
        </widgetType>

XML Source

<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">

    <widgetType name="dam_listing_selection">
      <configuration>
        <sinceVersion>5.7</sinceVersion>
        <title>DAM Listing Selection</title>
        <description>
          <p>
            This widget type displays a selection checkbox, that will perform
            ajax selection of given item, and the asset title.
          </p>
          <p>
            It requires the following fields configuration:
            <ul>
              <li>
                first field maps the document model, it will be used to
                display the title
              </li>
              <li>
                second field maps the label used as the tooltip of the
                document title
              </li>
              <li>
                third field maps a boolean representing the selection state
              </li>
              <li>
                fourth field maps the string identifier used to perform
                selection
              </li>
            </ul>
          </p>
          <p>
            It also requires the following variables to be present in the EL
            context:
            <ul>
              <li>
                provider: result provider used to get the list of items, its
                name will be used.
              </li>
              <li>
                listName: the name of the list that will hold selected items
              </li>
            </ul>
          </p>
        </description>
        <fields>
          <list>false</list>
          <complex>false</complex>
          <defaultConfiguration>
            <field>data</field>
            <field>data.dc.description</field>
            <field>selected</field>
            <field>data.ref</field>
          </defaultConfiguration>
        </fields>
        <categories>
          <category>hidden_listing</category>
        </categories>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /dam/widgets/listing/listing_ajax_selection_box_with_title_widget_template.xhtml
      </property>
    </widgetType>

  </extension>